home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _databases / databases / _finder / !FINDER / !HELP < prev    next >
Text File  |  1992-07-26  |  6KB  |  141 lines
  1.  
  2.                                Finder version 1╖10
  3.  
  4.                         Copyright ⌐ Jonathan Marten 1992
  5.  
  6.  
  7. Introduction
  8.  
  9. Finder is an application for searching data files.  It is similar to my
  10. earlier DialCode application, which was an index of telephone dialling codes
  11. that could be searched on either the code or destination fields.  However,
  12. Finder can be extended with other index files simply by adding them to the
  13. application.
  14.  
  15.  
  16. The icon bar menu
  17.  
  18. When the application is run, it will appear on the icon bar with the
  19. ö!finderò sprite.  At this point, no data is loaded and clicking on the icon
  20. with Select will produce an error message.
  21.  
  22. To load a data file, pop up the icon bar menu and select the required index
  23. from the öIndexesò submenu.  The data file will be loaded, and the icon bar
  24. sprite will change to indicate the index that is loaded.  The currently 
  25. loaded data file is ticked in this menu.  To remove the data file from
  26. memory, without quitting the application, select it again in the öIndexesò
  27. submenu.
  28.  
  29. As well as the usual öInfoò and öQuitò options, the icon bar menu has a
  30. öSaveálistò option which will be unavailable until a search has been
  31. performed.  This allows the current search results to be saved as a text
  32. file, in the normal RiscOS way.
  33.  
  34.  
  35. The search window
  36.  
  37. When a data file is loaded, click Select on the icon bar icon to open the
  38. search window.
  39.  
  40. Enter the text to be searched for in the entry box;  all searching is
  41. case-insensitive.  If öExactáMatchò is chosen, the search text must match
  42. the selected field in the file exactly.  If öStartsáWithò is selected, any
  43. field in the file that begins with the search text will be matched.  If
  44. öContainsò is selected, any field in the file which includes the search text
  45. will be matched.
  46.  
  47. The two radio buttons on the right select which field of the file is to be
  48. matched;  their names will change to reflect the data in the currently-
  49. loaded file.  Select the first button to search on the first field (which
  50. the file is normally sorted on);  select the second button to search on the
  51. second field.
  52.  
  53. Click öSearchò or press Return to search the file with the current settings. 
  54. To widen the search (useful when öStartsáWithò is being used) click öBackò; 
  55. this removes the last character from the entry box and then performs the
  56. search.
  57.  
  58. A results list window will pop up showing the results of the search.  This
  59. list can be saved as a text file by using the öSave listò option on the icon
  60. bar menu.
  61.  
  62.  
  63. Data file format
  64.  
  65. A data file is a normal text file (the file type is not important) which can
  66. be created using Edit or any other editor, output from a database program
  67. etc.  The first few lines of the file contain general information:
  68.  
  69.  Line 1    The name of the data set.  This will be used on the öIndexesò
  70.            menu, in the window titles etc.  (öPostaláCodesò in the example
  71.            window above).  The maximum length is 30 characters.
  72.  
  73.  Line 2    What the first field represents;  this will be used to label the
  74.            first radio button (öPostáCodeò in the example window above). 
  75.            The maximum length is 12 characters.
  76.  
  77.  Line 3    What the second field represents;  this will be used to label the
  78.            second radio button (öPlaceáNameò in the example above).  Again,
  79.            the maximum length is 12 characters.
  80.  
  81. The data then follows:  one entry per line, with the first and second fields
  82. separated by a space.  The maximum lengths of the two fields are 10 and 40
  83. characters respectively.  It is recommended that the file data is sorted on 
  84. the first field, although this is not essential.
  85.  
  86. This data file must be placed in the öDataFilesò subdirectory within the
  87. application;  the next time the application is run, it will note the new
  88. file and add it to the öIndexesò menu.
  89.  
  90. To specify the icon bar sprite to use when that data file is selected,
  91. design a sprite and add it to to the öSpritesò file within the application
  92. directory.  The name of this sprite must be the same as the name of the data
  93. file.  If no suitable sprite is present, the default ö!finderò sprite will
  94. be used.
  95.  
  96.  
  97. Conditions, Acknowledgements Etc.
  98.  
  99. The Finder application is public domain, and may be copied and freely used
  100. or distributed by any person and on any medium as long as this documentation
  101. file is included unaltered.  Please report any bugs you may find, any
  102. suggestions for improvements or any inaccuracies in the data files to me
  103. (address below).  If you generate any new data files, then please also allow
  104. them to be distributed in the same way (I would appreciate your sending me a
  105. copy).
  106.  
  107. While the information in any data files supplied is believed correct and is
  108. supplied in good faith, neither the author nor any distributor of the
  109. software will accept any liability for incorrect, missing, spurious or
  110. out-of-date information obtained from this application, or any loss or
  111. damage resulting from the use or misuse of such information, however caused.
  112.  
  113. The öDialCodesò data file was downloaded from a BBS a very long time ago,
  114. and added to by me.
  115.  
  116. The öIndexMarksò and öNatPlatesò data files and sprites were created by
  117. William Hine.
  118.  
  119. The öPostCodesò data was obtained as a shareware list.  The original
  120. conditions and disclaimer are reproduced here:
  121.  
  122.        öThis file has been prepared by Peter Moore, using an Amstrad
  123.        PCWá8512 computer and LocoScriptá2 software.  It is believed to be
  124.        correct at the issue date (Aprilá1988), but it would be appreciated
  125.        if any errors found could be advised.  It is intended that the file
  126.        will be updated from time to time, as necessary.
  127.  
  128.        The information in the file may NOT be sold for commercial purposes: 
  129.        the British Post Office has given verbal permission for the
  130.        information to be released as public domain material.ò
  131.  
  132.  
  133.  
  134. Jonathan Marten
  135. May 1992
  136.  
  137. Post:   11 Carmarthen Close             Phone:  (0252) 542431
  138.         Farnborough                     Arcade: #387
  139.         Hampshire                       E-mail: jmarten@cix.compulink.co.uk
  140.         GU14 8TJ
  141.